Headers

Configure the HTTP headers to be sent as part of a Web API request. Headers can be defined for the whole API and for individual request methods:

• Common – Common headers are sent in every request generated by the actions in an API definition.
• Request-specific – Headers that are only sent in requests for the associated actions.

Headers are defined by entering a name and the required value. Values can include parameters, that dynamically add their values when the API is called.

The same name can be used for common and request-specific headers. Where this is the case, and both have a value configured in the API definition, the value of the request-specific header is used when the API is called.

This example shows an API request, created from an API definition:

• The request includes both common and request-specific headers.
• The Content-Type header has a value set in the common header that is overwritten by the value in the request-specific header when the API is called.
• The From header is populated with the value set in the email-address parameter.